An Education on Education

An Education on Education

There’s a lot of talk these days about free education for all and student loan forgiveness. I’m against both for very rational reasons. Hopefully you learn something new  or reevaluate your beliefs, but maybe you just get ticked off. That’s OK too.

For reference, I had a very expensive education. But it was at a good school (RPI)1 in the right major at the right time.2 So upon graduation, I was employed, well-paid, and ready to avoid snow for the rest of my life. That colors my views, but I think in the right ways.

Forgive and Forget
First, I’ll tackle loan forgiveness. The reason why student loans survive bankruptcy is simple. If you stop paying your mortgage, they take your house. You car loan? They take your car. But there’s no lien on your education, and no way to repossess it. It’s yours for life, or at least until you forget it. In a dystopian system, they could make you forget it, but they still wouldn’t have it back. That’s why you always owe what you borrowed for education.3

A forgiven student loan is essentially a scholarship or grant. Those are fine and good, but have completely different qualification criteria. You typically have to have good grades, and beat out other students. I got some grants and scholarships due to academic performance, but it only covered half my tuition. Those who performed better than I, or had greater financial need, got full rides. Makes sense!

Less Than the Paper It’s Printed On
The reason why I think all higher education shouldn’t be free is because of value. By value, I mean your earning potential after graduation. Some degrees are worthless. Actually, when you factor in opportunity cost – what you could have gained with the same time, effort, and money – they have negative value. Yes, I do include degrees at many for profit universities. Some say those universities tricked people into going there, and I’m sure some did. The government is definitely doing a lousy job of protecting students there. Maybe forgiveness is reasonable in those extreme situations (fraud), but I’d rather see a class action or government lawsuit for fraud repay students, instead of our tax dollars.

Let’s say you’re going to a good school. Your major and the job market still have a huge impact on degree value, and it changes over time. Switch to a democrat in the White House, defense spending goes down, as does the value of an aerospace engineering degree.4 Stringent (some would say overbearing) regulation on nuclear power plants has had the same effect on nuclear engineers. Those aren’t political statements, they’re empirical observations.

Is the right school and major enough? No. Another thing that vastly affects your earning potential is how far you go. I remember when a college buddy who was majoring in bio that he would have to get a MS degree just to be a lab tech or teach high school.5 Just about every scientific field other than computer science requires you to get a PhD to do anything useful. Many fields of engineering now expect a MS. It blows me away how many students enter college without realizing that.

Of course, you can still have the right major and degree at a reputable school, but it’s the wrong school! Most American universities are specialized in one field or another. Combined with reputation, it’s a big impact on value. For instance, MIT is one of the best engineering schools in the world, if not the best. STEM6 degrees from there are quite valuable.

But did you know that MIT offers majors in all sorts of liberal arts fields, such as languages, cultures, and literature/writing? Given that MIT is also one of the most expensive schools in the world, do you think this is a wise investment? What is the expected return on a writing degree from here vs. NYU or University of Iowa? (Hint: they are the MIT of creative writing.)

The Tuition is Too Damn High
So why don’t universities charge different prices for different degrees, when their value differs so wildly, and there’s clear data to prove it? Because the cost to educate them is roughly the same. You’ve surely heard about the soaring cost of education. Well, investigative reports show it’s not due to to professor salaries. Dependence on adjunct professors has skyrocketed, keeping educator payroll (vs. administrative) pretty stable.

Adjuncts are the bottom rung of professorship. They are part time teaching jobs that not only have low wages, but educators are paid only for the hours spent in the classroom, not preparing lesson plans or grading papers. Many work multiple jobs to get by and are on welfare and food stamps.

One theory behind the rise of adjuncts is a flooded labor market. Lately, more college students are unsure of what to do upon graduation. They don’t like their options, especially if they have a liberal arts degree, so they stay in school. They get an MFA or PhD, take on more debt. Now they’re qualified for a job that has a flooded market and the worst prospects for tenure we’ve ever seen.7

So if the actual teaching costs aren’t to blame, what is? Buildings. Turns out, your obscene tuition – and alumni gifts – go to new buildings and campus beautification.8 Why? Because prospective students rank campus beauty and amenities very highly when choosing a school.

My friend’s daughter is very smart and sensible. They toured several schools, but when they got to the Ivy League schools, she was smitten. “It looks like Hogwarts!” She’s right, and you know what? I did the same thing. I toured some schools with computer labs that were just a bunch of Macs and PCs scattered around a room. Then I visited RPI and saw rows and rows of high end Unix workstations from Sun and IBM.  And they were housed here:

VCCA big, beautiful chapel of stone and stained glass. It was like a sign from God.

Teenagers may be very smart and sensible (or not), but we’re asking them to make major life decisions – high risk investments – without the benefit of wisdom and hindsight. They are emotional thinkers, and architecture makes us emotional. So they weigh it much higher than they should, and colleges are using it to win them over.

A friend pointed out that administrative costs are also rising. That’s true, but I’ve read that most of that is related to buildings – it takes a lot of people to plan, build, maintain, and staff a $100M building. You know, like the arts building my alma mater, an engineering school, had built (way over budget, of course).

Finally, indiscriminately handing out loans makes it easy for schools to raise tuition. Since Reagan, politicians have been buying votes with easy money for houses, elevating home ownership to a basic human right, and causing the housing bubble and economic collapse of 2008. The same kind of thinking, applied to student loans, has created a tuition bubble. Unless we put that in check, tuition will continue to rise and Americans will be saddled with ever more debt.

Solutions

The first is mandatory mentoring. Before teens pick a school, force them to interact with professionals who have the job they think they want.9 Tell them which schools in their field are most respected, and what degrees are required. In other words, tell them up front what the minimum requirements are. We assume they know this, but they don’t, and neither do their parents. That wastes tons of time and money on the wrong school, major, degree, or all three.

Next, make schools collect data on employment rates and salaries by major. That’s the basic info a student needs to calculate his/her return on investment (ROI) for their chosen degree program. It should be part of the accreditation process and used for student loan qualification. People hate hearing this, but for the foreseeable future, chemical engineering majors at top engineering schools should qualify for much bigger student loans than art history majors at the same school. Or, for that matter, chemical engineering majors at Bojangles College of Book Learnin’ and Taxidermy.

That’s smart investing. You don’t reward schools for skyrocketing tuition by having taxpayers give everyone a free ride. That’s part of what’s caused this mess. Schools will erect gilded palaces with 24/7 concierges and we’ll foot the bill.

And those bills will only get bigger. People point to Scandinavian countries as a working model for free education, but ask someone from there how many “permanent students” they know. People studying into their 30s, getting multiple degrees, happily living off the stipend with no intention to graduate. Then consider that the US population is over 12 times larger than all of Scandinavia combined. Heck, California alone is 40% bigger. Imagine the tax burden this would cause. Actually, you don’t have to, just ask someone from Scandinavia what their tax rate is.

At the same time, a top student from a poor family should never think they can’t afford Harvard or MIT. It should be guaranteed!10 That’s how we raise the impoverished. Reward both students and universities who perform well.

Finally, is there an alternative to college? Mike Rowe has been pointing out for years that our society suffers from a false belief that colleges are the only good answer to employment, and learning a trade is a recipe for hard times. In reality, compared to many college graduates, welders and machinists make way better money, have better job security, and they spent less time and money on their education.

I know it’s not easy work, but it could be a lucrative path to artist or author. I’m willing to bet that many tradesmen have great stories. I know veterans do;  just look at Hemingway. Pulitzer Prize? Check. Nobel Prize? Check. College degree? Nope.

The Future

It’s fun to think about the future and what might disrupt education. The first, which is already happening, is distance learning and MOOCs (massive open online courses). A great example is the Online Master of Computer Science offered by Georgia Tech. For at least 25 years, Georgia Tech has been considered a top 10 engineering school, and by all accounts their distance learning program is legit. Meaning it’s just as rigorous as the one on campus, just cheaper and more convenient.

Given all the cheap adjuncts and grad students available to act as teaching assistants, you can have the star professors giving the lectures and scale this out to many students across the world.

You can also have educational tourism, in the same way you have medical tourism. That could play out in a few ways. First, note that undergraduate education, in STEM fields at least, is largely homogeneous. It’s there to prepare you for a graduate degree, where the real differentiation happens.

Therefore, a school abroad could gain a good reputation by licensing a curriculum from a top school. MIT Open Courseware has most of their material online for anyone to learn from. If a school could also license the assignments, tests, and grading policy, it would gain instant credibility.11

There has already been press about Americans attending German colleges for “free.” I can even see the same for us, brain draining the rest of the world because we don’t have enough students who get can into, say, top medical schools. Seems like a great alternative to a doctor shortage. I’m all for attracting the world’s best to America and fast tracking their citizenship and contribution to society (including taxes).

 

 

  1. Less famous for being the oldest engineering school in the country than for its 4:1 ratio, and I’m not talking gears. []
  2. Computer science during the dot com boom. []
  3. I know, this goes for any experience, educational or not, that you pay for with a credit card. Somehow we’re OK with credit cards getting screwed, maybe because the rates are so high and they’ve had shady/predatory practices and they make bazillions. []
  4. The recent increase in NASA’s budget was a big surprise and quite the exception. []
  5. Some states, including NY, require both a MS degree and a teaching credential to teach science. Despite the fact that a semester of college science teaches you more than a year of HS science. []
  6. Science, Technology, Engineering, and Math []
  7. But even before this, there was a sign. Elbow patches. I always thought they were cool, a symbol of knowledge and authority, a fashion statement made by professors (especially those in England). Then a friend told me no, it wasn’t a fashion statement. Professors were required to wear suits, and had their elbows on desks all day. They wore out the fabric, but couldn’t afford to buy new ones, so their wives sewed leather patches on them to keep it from happening again. This is why I won’t buy a new jacket with elbow patches, just as I don’t buy jeans with holes in them. It’s poverty as a fashion statement. []
  8. And, of course, the administration to run it all. []
  9. Yes, force, because they will probably be shy and insecure about it, and not realize adults get a big ego boost just from being consulted. Heck, I have to hammer this home to young professionals who already have a job. []
  10. I know Ivy Leagues are getting better making sure that happens, but only very recently, and only because they’ve been shamed by alumni donors. []
  11. I have several other ideas along those lines, especially for computer science. If you’re an international school who wants input from an authority on the tech hiring process, reach out. []

Upgrading to Grails 3

Preface

I’m upgrading an app from Grails 2.4 to 3.1 and thought I’d take share my thoughts and notes.

First, I want to say that I’m very grateful to the maintainers for all their hard work. I know this wasn’t easy.

Second, I’m not a full time coder anymore. Running a software/staffing company gives me lots to do. So although I’ve been doing Grails for a few years now, and Spring/Hibernate before that, consider me a casual user. Still, I have opinions – don’t we all? I’m sharing them because I want Grails to thrive.

As you know, Grails began as a way to make Spring/Hibernate development much easier. Over time, it grew a wonderful ecosystem, but it’s still Spring/Hibernate at its core.

When Spring 4 was launched, I attended an event where all the new features were explained, along with Spring Boot. The Spring people were very excited. But I kept thinking, “This is nice, but it’s still well behind Grails.”

The problem is, SpringSource made a lot of changes under the hood to deliver those features. And Grails, being a layer on top, had to be rewritten to remain compatible and up to date.

That means this upgrade is a necessary evil. Because I left Spring for Grails a few years ago, for me it means work and frustration with no benefit. That’s not meant to be an insult, but rather a compliment to Grails 2.x, which worked so well for me and thousands of others. I know the maintainers didn’t have a choice, but at no point during my Grails dev did I ever think, “Gosh, I wish Grails had a completely different architecture under the hood. It’s really holding me back!” Most of the Grails devs I talk to feel the same way. So I’m sorry this post isn’t quite ebullient.

I’m doing this now because I know this is the future,1 and doing it with a project still in development will be way easier. I have another an app in production and I want to take the lumps with a pre-launch project first.

Docs on upgrading are decent, but I had a lot of questions it didn’t answer. Hopefully this is helpful.

New Tech

Grails 3 incorporates the following technologies you’ll have to understand:

  • Gradle (replacing Gant)
  • YAML
  • logback (replacing log4j)
  • Asset Pipeline plugin

Gradle does seem to be a improvement over Ant (and I never liked Maven), but the Grails build system always worked great for me. YAML and logback seem simple enough, but I don’t see the value added, especially after hosting a talk on log4j 2, which looks great.

Asset Pipeline is a hands down win, and something you should be using in 2.x if you’re not already. I know a lot of people are still using the Resources plugin, but it’s time to move on.

I’ll add that the command line expects you to be running with JDK 8. run-app crashed immediately with a bytecode error and the answer was to set the GRAILS_OPTS environment variable to “-XX:-UseSplitVerifier -Xverify:none”. Later, I simply changed my JAVA_HOME to JDK 8, which doesn’t need that. I think we’re all ready to move on to Java 8 now anyway.

IntelliJ

Update: I want to share some inside info from a JetBrains employee. JetBrains uses votes and social media (Twitter complaints) to prioritize work. The Grails community has been pretty lax in voting for IntelliJ issues, hence we’re seeing core functionality like reload/debug half-broken for Grails 3. Please upvote issues, and comment if an issue is holding you back.

The Grails community is unanimous in it’s support for IntelliJ, and I previously wrote about why it’s better than GGTS (Eclipse). I believe GGTS has been discontinued as it was maintained not by the Grails team, but by the SpringSource tools team that makes STS. If your employer was too cheap to buy you IntelliJ before, you have an ironclad argument now.

I had to upgrade to the latest version to use Grails 3. I had put this off because I knew the Grails view was missing. Now it’s there for Grails 2 projects, but not 3. I didn’t realize how helpful it was until I lost it.

I used it to create my project, since in Grails 3 you create a blank project and copy your old project into it. First thing you need to do is pull up the Gradle tool window and click the refresh icon. As brilliant as IntellliJ is, it’s too dumb to realize this is a Grails project, even though it just created it. It thinks it’s only a Gradle project until you pull up the Gradle tool window and click the refresh icon. After this, you’ll see the Grails menus and your app available in the run configuration menus. Absolutely critical, yet not in the docs or automated for you, leaving some confusion.

Once Gradle is refreshed you can use the usual way of running it, but that has a glaring bug – environment variables you set in the run configuration are not passed on! This is a big deal, as you’ll read below, because environment variables are the standard way to do external config now that specifying files is not supported out of the box.

To get around this, use the Application run configuration. Go to ../grails-app/init and right click on Application.groovy to run/debug. Note: this is not your config file. That’s under conf, with a lowercase ‘a,’ see below.

However, there’s another problem – if you need to test SSL connections, you need run-app -https, and as mentioned that doesn’t work with environment variables. Since it’s local, I’m running with an insecure channel, but I’d like that fixed.

environments {
    development {
        grails.plugin.springsecurity.secureChannel.definition = [
                [pattern: '/**', access: 'REQUIRES_SECURE_CHANNEL']
        ]
    }
}

IntelliJ is so smart it notices when you’re using something without the source and docs, and suggests you grab it.  That is terrific.

But like the Gradle refresh, it also does things that are confusing. If I click on just about any file, including settings.gradle, the editor tab shows the file name. But when I click on build.gradle, the tab has the app name. I know I’ll get used to this, but it adds to the learning curve. And I’m chuckling as I write this and realize this is trivial compared to the fact that I now have to learn Gradle. Hey, at least it’s not Maven 🙂

Update: auto-reload broken?
I find that auto-reload on edit is now broken. Not sure why, but as linked there is a similar issue. Auto-reload works fine when I run ‘grails run-app’ on the command line. I can run that in the background and edit with IntelliJ, but I can’t debug. Losing the edit/test cycle with the debugger means troubleshooting is much slower now, especially with controllers, which are a real pain to unit test.

Update 2: Workaround (Thanks Josh!)
I’ve done more investigating. Basic reload via the grails run-app configuration works. However, there is a significant disconnect between the editor window and compiled code – the editor uses the code built on startup when determining if a line can have a breakpoint. So if you change the code and want to set a new breakpoint, it won’t work

In the comments, Josh pointed out that it was working for him when run via Gradle. Follow the docs to run/debug via Gradle. It worked, but I couldn’t find the console output. To see it, in the Console window that is showing Gradle tasks/times, click the toggle button with the tooltip “Toggle tasks executions/text mode.” Now you’ll see the console output.

Note that this still does not allow you to run via HTTPS like with run-app. It’s good enough for now, but please upvote this issue to make it better for everyone.

Configuration

Grails 3 introduces an application.yml file that is used by default. Even though the docs describe it as “an alternative format,”I have found at least one setting that must be set in application.yml:

https://github.com/grails/grails-core/issues/10005

We do not have a definitive list of what must be defined in the YAML file. That is the only one I noticed, but there certainly could be more. If you’re going to use application.groovy, you may want to add a check in BootStrap.groovy and exit on missing settings.

So why was YAML chosen? Because Spring Boot uses it, and according to Graeme Rocher it’s fully machine writable where Groovy sometimes isn’t (or not easily). But for whatever reason, the helpful comments in Config.groovy are gone. If you’re upgrading, you can just copy them all over.

If you’re converting to Groovy or vice versa, this SO question may help:

http://stackoverflow.com/questions/30057329/convert-configuration-file-application-yml-to-application-groovy-in-grails-3-x

One thing you’ll need to change is your defaultPackage, since Grails create-app doesn’t ask for it. I had originally converted all the YAML to Groovy, then found defaultPackage is ignored when in application.groovy. For now, this is my whole application.yml, but expect I’ll need to add more:

grails:
    codegen:
        defaultPackage: com.madeupname.web

Which takes precedence if you use both? Short answer is “don’t do that!” Make sure there is zero overlap between the two config files. You won’t get an error or even a warning, and in my test YAML consistently overrode Groovy, but you can’t assume that will always be the case. The recommended approach is to stick with application.yml and use Groovy whenever you need to programmatically set values. You’ll also have to keep an eye out for plugins modifying either file.

If you need external configuration files, you’ll have to do some hacking. I recommend reading this thread on the dev list. But the general recommendation is to use system variables/command line arguments (which take precedence) or environment variables (see Spring PropertySource). This is probably what you need to do if you’re deploying to a PaaS like Elastic Beanstalk, Cloudbees, Jelastic, etc.

Update: external config
Thanks again to Josh in the comments, I found very clear instructions from Haki on how to enable external config in Grails 3, and it’s pretty easy. As instructed, I added the VM option to my run config, updated my Gradle config file, and made sure the format was YAML. Maybe you can use Groovy config for this, but I played it safe.

With reload not working properly for debug in the Application and run-app run configs, you have to use Gradle, which requires external config files because IntelliJ doesn’t support setting environment variables for Gradle tasks.

So it would be great if you could upvote this issue to support environment variables.

Plugins

Because of the sweeping changes to the architecture, most (if not all) plugins need to be updated to work with Grails 3. In many cases the change is small, but you’ll want to check what the latest compatible version is.

Unfortunately, the Grails plugin site, while improved, still has issues. The good news is that it separates Grails 3 compatible plugins. The bad news is that the current version could be way off. For example, Spring Security UI needs a lot of supporting libraries, including Hibernate4 plugin. You can find it here:

https://grails.org/plugin/hibernate4

Problem is, the actual latest version is 5.0.7 and definitely not 5.0.0.RC1. There’s also no clear list of required and optional dependencies, you need to look to the plugin docs for that. If an official/core plugin has the wrong version listed, I’m forced to distrust every version on the plugin site. I’m also wondering how that info is added, and I suspect it’s manually, since the fields plugin has its source and issues links reversed.2

Another concern is that after a year, the Grails 3 compatible Mail plugin is still a release candidate, and Spring Security UI is just a milestone release. This is going to give a lot of people pause when considering upgrading.

Mail
The MailService class changed, but it’s no longer needed. Config is largely unchanged, except for the environment variable placeholders. This is for Gmail:

grails {
    mail {
        host = '${MAIL_HOST}'
        port = '${MAIL_PORT}'
        username = '${MAIL_PASSWORD}'
        password = '${MAIL_USERNAME}'
        props = ["mail.smtp.auth":"true",
                 "mail.smtp.socketFactory.port":'${MAIL_PORT}',
                 "mail.smtp.socketFactory.class":"javax.net.ssl.SSLSocketFactory",
                 "mail.smtp.socketFactory.fallback":"false"]
    }
}
grails.mail.default.from = "[email protected]"
grails.mail.default.to = "[email protected]"

Scaffolding
You have to change very instance of:

static scaffold = true

to

static scaffold = Classname

I also found a potential bug where the configuration setting domainSuffix is only changing the model name and not what is expected in the view. The workaround is to remove the domainSuffix setting and update all your controller responses to remove the word “Instance.” So companyInstanceList would be changed to companyList, and the same with count, etc.

Spring Security
I use S2 core and UI plugins, which must be updated. For S2 UI, you must specify plugin and library dependencies. In particular, you need to specify a number of GORM libraries, and it’s not clear why. The docs do not list in one place every plugin you (likely) need. Here’s my build.gradle config for both plugins:

compile 'org.grails.plugins:spring-security-core:3.1.1'
compile 'org.grails.plugins:spring-security-ui:3.0.0.M2'
compile 'org.grails:grails-datastore-core:5.0.7.RELEASE'
compile 'org.grails:grails-datastore-gorm-support:5.0.7.RELEASE'
compile 'org.grails:grails-datastore-gorm:5.0.7.RELEASE'
compile 'org.grails:grails-datastore-simple:5.0.7.RELEASE'
compile 'org.grails:grails-datastore-gorm-hibernate4:5.0.7.RELEASE'
compile 'org.grails:grails-datastore-gorm-hibernate-core:5.0.7.RELEASE'
compile 'org.grails.plugins:mail:2.0.0.RC6'

Other

Traits
It’s not config, but I had a class in src/groovy that used the @Validateable annotation, and now wouldn’t compile. You need to make it implement the Validateable trait (interface) instead.

Looking back, it does not seem that bad, but without knowing any of the above it was an exercise in frustration. Hope I save you some trouble!

  1. Kind of like when I moved from Subversion to Git. []
  2. While the main Grails site has a button to fix any page, the plugin sub-site does not, and there’s no docs to fix plugin data. []

Notes From Thee Linux Conference (SCALE 14)

I attended SCALE for the first time this past weekend and highly recommend it. They had not only talks, but all-day training sessions for which you would reasonably expect to pay hundreds of dollars. I also got to meet Jenkins founder Kohsuke Kawaguchi, Apache Bigtop founder Konstantin Boudnik, and Randal L. Schwartz, whose Learning Perl I referenced countless times back in my Perl days. Plus I got to spend quality time with good friends.

Here are my notes from talks. I’m no longer in admin/DevOps, so I picked talks that piqued my interest.

Scaling – from Joel Salas of HauteLook
They are an ecommerce site that has to deal with high burst traffic. It’s LAMP, so not entirely applicable to my stack (Grails), but there were some good tips that many high traffic sites could use:

  • Tuned, a Linux daemon that collects data and allows you to set optimal system defaults that can have a big difference.
  • He prefers Gatling over JMeter for load testing. (I’ll note I’ve had good success with the latter, but never hurts to learn about new tools.)
  • Varnish, in addition to a CDN.
  • SolrCloud for search.

Postgresql EXPLAIN PLAN – from Josh Berkus of Red Hat

Postgresql for big data/data science – from Jim Nasby

  • Slony and Londiste should no longer be used
  • Can scale to 80+ cores
  • pg_shard – for sharding/replicating PG tables
  • cstore – columnar data store
  • PGStrom – allows PG to utilize the GPU
  • PostgREST –  give any PG DB a REST API
  • Toro DB – Mongo DB compatible JSON document DB, but built on Postgresq. Can save you a ton of space and I/O.

Dart by Randal Schwartz

  • Looking really good, lots of progress made, in use on big projects (100+ devs) at Google
  • Works on Node.js
  • Lot of work into making it compile into readable JavaScript
  • Great features taken from Java: types, reflection, concurrency, async futures, streams
  • Removes unused functions on packaging (smaller downloads, e.g., won’t include all of jQuery)
  • Pub is where everyone shares open source packages: https://pub.dartlang.org/
  • Free book to learn, kept up to date: https://www.dartlang.org/docs/dart-up-and-running/

Painless Documentation (What If You Won the Lottery?)

Abstract: Sometimes good things happen to good people. When something good takes away someone you depend on, will you be prepared to go on without them?  With a little low effort documentation and knowledge transfer, they can leave you without torpedoing the schedule.

People often ask, “What if you got hit by a truck?” to pose a hypothetical around losing you. But what an awful thought! And in the corporate world, highly unlikely. Some form of winning the lottery, however, is not only possible, but probable. What if a developer on your project…

  • goes on maternity/paternity leave?
  • has to move?
  • goes on extended vacation or sabbatical?
  • goes to grad school?
  • retires?
  • gets a new job?

Really, that last one (along with the errant bus) is the most dangerous and represents management’s true fear: someone leaves NOW. With no time to aid in a smooth transition. I should note that in the US, two weeks notice is a courtesy typically given by both employee and employer, but not a law.1 And many tech departments have  a policy of paying you for two weeks, but walking you to the door as soon as you declare your intent to quit.2

That, my friends, is what drives many project management policies, especially those regarding documentation. I think it’s so obvious to management that they never explain it to employees this way. “We’re afraid you’ll leave us.” If they said that, perhaps you’d start wondering if there was someplace better. But really, most employees would totally understand if you flipped it on them:

  • Do you want to go on vacation and not have to give us a ton of notice (or lie and call it sick time)?
  • When you leave, do you want your coworkers, who have to take over your work, to hate you for leaving such a mess?
  • Do you want to own that piece of code that nobody wants forever?

OK, the second one might be a loaded question, but odds are you don’t. If you don’t do continuous documentation, you have a ton of work to do in your last two weeks. You perform this duty with all the work ethic of a graduating senior who already got into college. Maybe you convince your boss to accept a code walk-through in lieu of written docs. They’ll think they understand everything, but when it breaks or needs modification, it takes them forever and they silently curse you. Wait, no they don’t! You’re not here! They bad mouth you to the boss directly. Hope you weren’t counting on either as a reference.

Of course, by “you” dear reader, I’m using the royal you. You would never do that. Why, you’ve had that done to you!

I get that nobody enjoys documentation. Most devs don’t enjoy anything that isn’t coding, or maybe designing. Heck, I’ve seen people get fussy about filling out a time card, and that takes what? 2 minutes a day? They know the effort is low, but something about the task generates psychological resistance. I think a big part of it is not seeing any direct benefit, or putting a low value on time delayed benefits. Hopefully the preceding alleviates some of that. Still, I’m going to make this as painless as possible. What follows are the simple guidelines to provide redundancy while maintaining productivity and code quality.

Bug/Issue Tracker
I would think this goes without saying, but let’s say it anyway. All new features, bugs, and improvements go in your issue tracker. Each entry should be considered a live document containing both the requirement (user story, etc.) and design.

Pro tip: keep it classy in the issue tracker. If they don’t have access already, the client eventually will and you don’t want to be caught badmouthing anyone. Not even the vendor, because someone picked them, and be it the client or your company, mud slinging won’t win you any friends. My general rule is to never leave a paper trail when blowing off steam.

Version Control System
Shoot, if I’m mentioning the issue tracker, better mention this. Not using version control is one step away from not saving your work, or taking backups.3 Make your commit messages meaningful. In multi-file commits, I list each file and a brief explanation of the change.

Most importantly, I integrate the code repository with the issue tracker. Most systems make this dead simple; you just type the issue ID and it’s connected automatically. In Eclipse,4 I use Mylyn and plugins for my issue tracker and code repo, combined with a commit template, to make this automatic (it all works out of the box). If you need to fix a bug for that feature later, you’ve got all the commits and files for it listed in the issue tracker and can usually click on the commit message to see the source diff between versions. Very handy for the new person taking over (which may be you if you haven’t touched the code in a few months).

Note: if you can’t integrate your VCS and issue tracker, you probably have a lousy issue tracker. Actually, I bet someone chose a general project management tool instead of a real bug tracker. I use JIRA (I also like FogBugz), but there are so many choices and they all do this. Heck, the super simple issue tracker that comes with Github does this. You can’t get a lower effort, higher value documentation practice than adding the bug ID to your commit message. Even when you forget, git lets you amend it pretty easily.

Design Reviews
Your design does not have to be exhaustive, but should provide a development road map for that feature and give you confidence in the estimate. Have at least one other person review it (and your estimate) for omissions and general sanity.

Code Reviews
Similar to the above, get another pair of eyes on the code. If it’s just one or two people instead of the whole team, make sure they do it solo and take notes. That’s the only true test for readability, which is the most important aspect of your code.5 If you walk them through it, you’ll never know if your code is clear enough for someone to take over when necessary.

Note: for both design notes and code comments, don’t forget to document surprises and gotchas. We’ve all had the experience of starting with a sane, obvious solution, only to discover some obscure, insane obstacle, usually in some system we can’t touch. Be a hero and document that in the issue and in the code. In fact, if you only documented gotchas, you’d still save everyone a number of headaches down the road.

Bonus: Group Training
While in Kyiv, I saw a great talk about code clarity by Venkat Subramaniam.6 In his presentation, he pointed out the difference between readability and familiarity. All languages have idioms, and if you code in them long enough, or read enough good books on them, you’ll pick them up.7 The thing with idioms, though, is that their intent is often unclear to the uninitiated, who are unfamiliar with the language constructs being employed. To a practitioner, however, it’s perfectly readable. We may seek to correct this by banning idioms, but the better choice is to make everyone a better language practitioner.

One way to do this is through code reviews, as mentioned. But another is through group training. If you’re making a platform switch, the best way to do this is to hire a language and/or framework expert to coach the team, because the point is to get everyone on the same page, writing code that is familiar to everyone. But it could be something as simple as a company sponsored study group, or even a short, daily discussion of a single idiom. Basically, you want to idiom-proof your team. (Sorry.)

What does your team do to foster knowledge sharing? Please, share your thoughts in the comments.

  1. Well, not a law in all states. See at-will employment. Even that has exceptions, especially during layoffs. Consult an attorney if you really need to know this stuff. []
  2. Presumably to prevent sabotage or industrial espionage, based on the assumption that you didn’t know this policy existed before you gave notice and didn’t implement anything nefarious before you gave notice. []
  3. I personally think of commits as off-site backups of my code. []
  4. Note: I’ve since switched to IntelliJ. []
  5. Well, other than correctness, but if it’s not readable there’s a good chance it’s incorrect, or soon will be. []
  6. I highly recommend attending one of his talks if you get a chance; he’s a very dynamic speaker. []
  7. A good example are the “Effective” books for C++, Perl, and Java. All have different authors, but all teach you the same thing: how to best your structure code, including patterns and idioms. []

GGTS vs. IntelliJ IDEA

For years, I’ve been hearing about the superiority of IntelliJ over Eclipse from its enthusiastic fan base. However, I couldn’t find any evidence to persuade me to switch. I’ve had my frustrations with Eclipse, to be sure. I’d love to find a great replacement for any of my tools. But nobody could give me a clear reason. From its fans, I heard, “It’s just better.” Same endorsement I hear for OS X. And JetBrains’ feature list doesn’t having anything over GGTS. I needed a real reason to switch.

Well, earlier this month I got one. I won an IntelliJ Ultimate license at an LAJUG raffle. I now agree that IntelliJ is better, and I have clear reasons why!

The folks at JetBrains have always had a reputation at being language gurus. They’ve been able to provide support for languages faster than others, and frequently more comprehensively, even for dynamic languages. They’ve even invented a language. While I knew this, I assumed that for Java and Groovy GGTS would be on par due to it’s heritage. Unfortunately, it’s not.

To give you a clear example, I recently generated static scaffolding for a domain class in Grails 2.3. I noticed the controller uses the respond method instead of render, and the respond docs are not comprehensive. I tried opening the declaration to look at the code and it doesn’t work – GGTS has no idea where the code for controller methods reside.

I also tried some static imports of an embedded enum and again, GGTS had issues. Autocomplete (ctrl-space) didn’t work, nor did highlighting. In other parts of the code, it couldn’t locate the declaration for classes where a dynamic finder (e.g., User.findAllByName) was being invoked! In some classes it did work, but overall it was inconsistent. To be clear, there were neither compilation nor runtime errors – the code was fine, and to be honest there wasn’t much of it. This is a pretty new project.

As a test, I decided to import it into IntelliJ. The first attempt failed. I had it import it from Git, then parse the Eclipse project file when that was offered as an option. I was close to giving up as it didn’t even seem to recognize it as a Grails project, and there was no clear way to fix it in the configuration. But instead of giving up, I deleted the project and reimported it, this time ignoring the .project files and letting it discover the Grails nature on it’s own. Much better!

I opened the troublesome controller and noticed everything was properly highlighted, including those pesky enums. It understood the code and could open the declaration of all the classes, even those using a finder (and autocomplete was pretty nice). But best of all, it had no problem opening the declaration of those Grails controller methods like respond and render! This is a big win and clear advantage over GGTS.

I then checked out running/debugging. I’m a big fan of the debugger and had heard that IntelliJ’s method involves attaching to a separately run/managed Tomcat instance. This may have been the case in the past, but I was able to run and debug my Grails app the same way I do with GGTS – right from the IDE with “run-app -https”. No extra hoops to jump through.

Couple things I wish were better with IntelliJ:

  • Key bindings are not mnemonic. I’m sure they can be updated, but the choices strike me as odd.
  • Help window usability is bad, which is odd considering overall usability is good. Examples:
    • mouse scrolling is page-up/down, not smooth scrolling
    • searching highlights phrase – but you can’t turn it off!
    • back/forward buttons have no effect

Considering that help pages are the last refuge of the hopeless, making that a good experience is really important to customer satisfaction.

Couple tips for Eclipse/GGTS/STS users:

  • Search for “CamelHumps” in settings to navigate camel case like Eclipse
  • Play around with the Groovy/Java code style, in particular indentation, to match what you’re used to.