Wondering what’s next for npm?Check out our public roadmap! »

    airtable-change-detector

    1.2.0 • Public • Published

    Airtable Change Detector

    npm version

    Detects changes on an Airtable table by storing previous state for each row in a field of your choosing. This can be used to perform logic (like webhooks) on field changes.

    Package is 1._._ because it's used in production and we have no plans on changing API. However, it is undertested. Please add tests if you can! There is only one source file.

    Installation

    npm install airtable-change-detector --save

    Airtable Setup

    Required: the following fields on tables that you want to detect (names can be configured):

    • Meta

      Long text field. Stores the previous row state as serialized JSON

      Meta

    • Last Modified

      Last modified time field. Used to query which rows have changed. You can set this to only fields you care about, but by default all fields are stored in Meta

      Modified

    Optional You can also include the optional field:

    • Last Processed

      Date field. Stores the last time the detector detected a change.

      Processed

    Usage example

    This example uses all available options for ChangeDetector.

    const ChangeDetector = require("airtable-change-detector");
     
    const base = new Airtable({ apiKey: process.env.AIR_KEY }).base(
      process.env.AIR_BASE_ID
    );
     
    // You can create multiple ChangeDetectors for each table you want to watch.
    const myTableDetector = new ChangeDetector(base("MyTableName"), {
      writeDelayMs: 100, // Delay between Airtable writes.
      metaFieldName: "MyMetaField", // Defaults to `Meta`
      lastModifiedFieldName: "My Last Modified", // Defaults to `Last Modified`
      lastProcessedFieldName: "Last Processed", // If not included, detector will not write this field
      sensitiveFields: ["Address", "Birthdate"], // Fields not to include in `Meta`s previous state. Useful for keeping data deletion easy.
      autoUpdateEnabled: true // Defaults to true. If disabled you need to, when ready, pass an array of records to the function myTableDetector.updateRecords() to mark the record(s) as having been processed. It is recommended that you 'await' the return of the function to ensure a successful update.
    });
    myTableDetector.pollWithInterval(
      "pollingNameForLogging",
      10000, // interval in milliseconds. `pollWithInterval` will wait for both interval and work to complete
      async recordsChanged => {
        const statusFieldName = "Status";
        const colorFieldName = "Color";
        console.info(`Found ${recordsChanged.length} changes in MyTableName`);
        const promises = [];
        const someSetupConfig = await mySetup(recordsChanged.length);
        recordsChanged.forEach(record => {
          // Each `record` is an Airtable record in the node API with extra fields added including:
          // record.didChange(field) returns true if the field changed (or is new) between the last observation and now
          // record.getPrior(field) returns the prior value for `field` or undefined
          // See `enrichRecord` for more added methods
     
          if (record.didChange(colorFieldName)) {
            // Ex: send new color value to webhook
            promises.push(axios.post(myWebhookUrl, { newColor: record.get(colorFieldName) }));
          }
          if (
            record.didChange(statusFieldName) &&
            record.getPrior(statusFieldName) === "New" &&
            record.get(statusFieldName) === "Assigned"
          ) {
            promises.push(doSomeAsyncLogic(someSetupConfig));
          }
        });
        // If doing many Airtable writes, be careful of 5rps rate limit
        return Promise.all(promises);
      },
      // errFunc is optional. If absent, the error will be logged to console and retried after interval.
      // In that case, the recordId will not be logged.
      async (err, recordId) => {
        // recordId will be passed if the error is specific to a record
        // (ex: the Meta field for a record isn't valid JSON because its been edited manually)
        if (recordId) {
          console.log(`Error for record ${recordId}:`);
        }
        console.log(err);
        await sendAlertingWebhook(err);
      }
    );

    Caveats

    • All comparison for the sake of change detecting is done with lodash's isEqual
    • By default, changes are only detected ONCE. If your change logic fails, you could:
      • Retry it yourself
      • Modify a field that is watched by Last Modified field. The change detector will fire again for the field you changed.
      • Remove the watched field that you were reacting to in the lastValues Meta property. The prior value would be lost. (this is complicated and we may provide an API if there is interest)
      • Optionally disable the auto update capability and invoke the updateRecords function yourself. See the option autoUpdateEnabled above

    Info

    This was created by @alexquick to poll airtable at an interval for mutual-aid-app.

    Development setup

    npm i // Initial install
     
    npm run lint // Find lint issues
    npm run fix // Attempt to fix lint issues
    npm run test // Run mocha tests

    Contributing

    1. Fork it
    2. Create your feature branch (git checkout -b feature/fooBar)
    3. Commit your changes (git commit -am 'Add some fooBar')
    4. Push to the branch (git push origin feature/fooBar)
    5. Create a new Pull Request

    Install

    npm i airtable-change-detector

    DownloadsWeekly Downloads

    8

    Version

    1.2.0

    License

    MIT

    Unpacked Size

    95.1 kB

    Total Files

    14

    Last publish

    Collaborators

    • avatar