Feature/setup wizard

[Alapan]

Closes #922

Important changes:

• Created a server method to check the value of a flag called initialSetupComplete. If this returns false, an initial setup wizard is to be shown.
• The wizard allows an admin to configure settings for the instance.

[brylie]

Since this code is relying on a server method, it is asynchronous. So, we need to handle the return value from checkRequiredSettings in a callback:

// Instead of
// var configRequired = Meteor.call("checkRequiredSettings");
// It should read

// Get a named reference to current router
// for use inside the server method callback
const currentRouter = this;

Meteor.call("checkRequiredSettings", function (error, result) {
  // if error....
  // throw error message

  // check the result of the method call
  if (result === false) {
    // If checkRequiredSettings returns false 
    Router.go("settingsWizard");
  } else {
    // call this.next() using the currentRouter variable from above
    currentRouter.next()
  }
});

[brylie]

Good work so far. Just a couple of minor details to catch at this point.

[brylie]

Move this method call to the AutoForm.onSuccess callback.

[Alapan]

@brylie I made the changes you suggested. However, I made a slight change in the logic - I have introduced a new field initialSetupComplete in the Settings collection. Otherwise, a setting created through the program is not persisting across multiple templates. So if initialSetupComplete is set to true when the relevant method is called through Template 1, the value is becoming undefined when it is checked through Template 2.

I have also removed the alert logic from the master layout file. Currently the alert is not being shown anywhere. Please review.

[brylie]

Ok, make sure that the problem is not related to meteor restarting when editing the project sourcecode. I.e. Meteor.settings may be reset each time we edit a project file, but should persist between page views.

If you take the collection approach, be sure to create a publication that only publishes the initialSetupComplete field from the settings collection document. Otherwise, we may inadvertently publish sensitive information from our settings collection.

[Alapan]

I made the changes.

[brylie]

Great! :-) Is this ready for review/merge?

[Alapan]

@brylie Yes, this is ready for review.

[shaliko]

@Alapan project stop works for me if I do meteor reset and try open any page. Looks like infinite loop.

[Alapan]

@shaliko I made a small change. Could you please test and let me know if you are still getting the same error?

[brylie]

When starting Apinf without any settings, i.e. without the --settings ... flag, I get the following error:

Error: After filtering out keys not in the schema, your object is now empty

One goal of this task is that Apinf should start with no initial settings, so the Wizard can display.

[brylie]

It seems like /server/startup.js may need significant re-work/review here. Specifically,

• Lines 11 and 24 attempt to insert the Meteor.settings object into the settings collection without verifying the structure of that object
  • initially, Meteor.settings has the following structure { public: {} }, which doesn't contain any relevant settings
• There are two large sections of that file with duplicate functionality (lines 4-12 and lines 20-24)
  • refactor this code, so that it only runs once
• We should not call Meteor.call("createApiUmbrellaWeb") without first verifying that API Umbrella settings have been stored in the Settings collection
  • I.e. all of code may be refactored to first use the Settings collection as opposed to the Meteor.settings object
  • The Meteor.settings object will be a temporary placeholder for settings, so they can be persisted in the Settings collection
• Any API Umbrella related methods should only run if there are valid API Umbrella settings in the Settings collection
  • The 'Sync API Umbrella Users and API Backends' SyncedCron job should only start if API Umbrella settings are present
    • the job, including any sub-methods, should check the Settings collection, rather than the Meteor.settings object
  • Meteor.call("syncApiUmbrellaUsers"); and Meteor.call("syncApiBackends"); should also only run if API Umbrella settings are stored in the Settings collection.

[brylie]

We cannot figure out how to get the settings wizard to display.

[Alapan]

Currently, after running meteor reset and then meteor (without the settings file), when a user registers successfully, he is redirected to the wizard. However, I am facing a problem setting the Host name to http://localhost:3000 in the wizard, as the application returns an Unknown validation error. Setting the host name to something like http://example.com works, though.

Also, even after configuring the settings successfully, the following errors are being seen in the console:

1. [TypeError: Cannot read property 'clientId' of undefined]
2. [TypeError: Cannot read property 'username' of undefined]

[brylie]

Ah, yes. We had the same validation issue, possibly because of the port number.

As a second thought, it is probably unnecessary to provide the HOST value for the Apinf platform, since Meteor is already aware of this value, so lets deprecate that from the setup wizard/settings.

[brylie]

@frenchbread, what is your recollection of why we add the host settings in config.json? I think it had something to do with the dashboard.

[brylie]

@Alapan regarding the 'clientId' and 'username' errors, we need to check the existance of these fields before trying to use them. Try commenting out lines 11 and 24 of server/startup.js, as mentioned above.

[bajiat]

@Alapan and @shaliko Could you do some pair programming on this one to try solve the issues Alapan is facing? Sometimes even just explaining the problem to someone else might already help. Shaliko is not available 9 May, but should be back at work 10 May.
@brylie said he was just quessing to a certain extent what the problem was.

[Alapan]

I tried commenting the lines as @brylie suggested, but it didn't help. Please note, there was no problem in running the application - just that those 2 TypeErrors are present after filling in the settings details.

[brylie]

Ah, I understand now. Are they happening when you submit the form? It may still be a validation problem, where the schema is not passed in the fields it needs for validation.

[brylie]

@shaliko are you available today to help troubleshoot this task?

[shaliko]

@brylie Today joining to this task.

[Alapan]

@frenchbread Done.

[jykae]

@frenchbread As discussed I assign myself to check out this as you have work on the other PR.

[frenchbread]

Thanks @Alapan @jykae

[jykae]

@Alapan Reviewing

[jykae]

@Alapan This works and looks good. I am merging in.

Editor and Mail cannot be enabled because some autoform validation bugs. Discussed with @bajiat We have issue #961 for email and raised now in planning. Editor is then another case what we decide to do with that in future.