Главная страница>Исходный код ASP>Другие категории
Скачать

Вебсинхронизация

Websync похож на aws s3 sync с автоматической инвалидацией CloudFront и многим другим.

Синхронизация Websync предназначена для замены aws s3 sync . Websync, как и интерфейс AWS, синхронизирует локальные каталоги с префиксами s3 и наоборот. Websync расширяет эти функции, автоматически создавая оптимизированные аннулирования во всех связанных дистрибутивах CloudFront и предоставляя выразительную систему конфигурации (поверх интерфейса CLI) с JSON или JavaScript, а также программный API.

Оглавление

  • Установка
  • Использование
  • Файлы конфигурации
  • API предмета
  • Система признания недействительной
  • Подстановочные политики
  • Дорожная карта

Установка 

 # Install global cli, the `websync` command
npm i -g websync
# Install local
npm i websync

Использование

команда вебсинхронизации 

 # Parse configuration from `websync.json` or `websync.js`
websync
# Parse configuration explicitly
websync --config ./myConfig.js
# With command line options
websync ./www s3://mybucket.io
# General
websync [source] [target] [...options]

Параметры

  • source Контейнер исходного кода (локальный каталог или сегмент S3): ./myDirectory
  • target целевой контейнер (корзина S3 или локальный каталог): s3://my-bucket
  • config Явный файл конфигурации (JSON или JavaScript): --config ./myConfig.json
  • include шаблон Glob для фильтрации файлов (из источника), чтобы включить: --include **/*.ext
  • exclude шаблон Glob для фильтрации файлов (из источника), чтобы исключить: --exclude **/*.ext
  • diffBy Переопределить свойство, по которому различаются элементы ( modtime или size по умолчанию: modtime ): --diffBy size
  • wildcardPolicy Переопределить политику подстановочных знаков ( majority , unanimous или minority по умолчанию: majority ): --wildcardPolicy unanimous
  • wildcardAll Добавить подстановочный знак ко всем путям недействительности (ПРИМЕЧАНИЕ: это не меняет разрешение пути недействительности), полезно для признания недействительными путей строки запроса: --wildcardAll
  • invalidateDeletes Недействительные пути для элементов, удаляемых из цели. Полезно в ситуациях, когда вы не хотите, чтобы пользователи больше имели доступ к элементам: --invalidateDeletes
  • distribution Один или несколько идентификаторов распространения CloudFront (ПРИМЕЧАНИЕ: это переопределяет обнаружение раздач): --distribution <DIST ID> --distribution <ANOTHER DIST ID>
  • yes Пропустить все запросы с ответом «да» (ПРИМЕЧАНИЕ: websync предупредит вас, если будет сделано более 500 аннулаций, поскольку для этого потребуется оплата): --yes

ПРИМЕЧАНИЕ . Дополнительные параметры доступны в файлах конфигурации.

ПРИМЕЧАНИЕ . Все аргументы командной строки ОТМЕНЯЮТ параметры файла конфигурации. Кроме того, требуются source и target , но они могут быть предоставлены через CLI или файл конфигурации.

Файлы конфигурации

Файлы конфигурации могут предоставлять все параметры, доступные в CLI, с добавлением modifiers — гибкой системы предоставления явных аргументов для операций S3 put.

Объект модификаторов

Объект-модификатор файла конфигурации — это объект, в котором keys являются шаблоны Glob, а values — S3.putObject Params , или функция, которая возвращает либо S3.putObject Params , либо Promise, который разрешает S3.putObject Params . Обратите внимание: если предоставлена ​​функция (асинхронная или нет), она будет вызываться с одним аргументом Item , который будет представлять файл или объект из контейнера SOURCE . ПРИМЕЧАНИЕ . Исходные файлы могут соответствовать нескольким модификаторам, что позволяет сохранять СУХОСТЬ.

Примеры

Конфигурация JavaScript. См. пример контекста. 

 const Path = require ( 'path' )

const DOWNLOAD_CONTENT_TYPE = 'application/octet-stream'
const DOWNLOAD_TAG = 'Downloadable'
const REDIRECT_TAG = 'Redirectable'

const makeDispositionName = fileName =>
  ` ${ Path . basename ( fileName ) . split ( '.' ) [ 0 ] } - ${ Date . now ( ) } ${ Path . extname ( fileName ) } `

module . exports = {
  source : './public' ,
  target : 's3://websync-complex-example-bucket' ,
  modifiers : {
    // This matches all files, provides Plain Object
    '**/*' : {
      Metadata : {
        'source-user' : process . env . USER ,
      } ,
    } ,
    // Matches all files in downloads, provides a synchronous function
    'downloads/**/*' : item => ( {
      ContentType : DOWNLOAD_CONTENT_TYPE ,
      ContentDisposition : `attachment; filename=" ${ makeDispositionName ( item . key ) } "` ,
      Tagging : DOWNLOAD_TAG ,
    } ) ,
    // Matches any file with the `.redirect` extension, provides an asynchronous funcion
    '*.redirect' : async item => ( {
      WebsiteRedirectLocation : ( await item . read ( ) ) . toString ( ) . trim ( ) ,
      ContentType : 'text/html' ,
      Tagging : REDIRECT_TAG ,
    } ) ,
  } ,
}

Конфигурация JSON. См. пример контекста. В приведенном ниже примере шаблон !*.* соответствует любому элементу без расширения , т. е. «another-page», и переопределяет подразумеваемый Content-Type на text/html чтобы иметь чистые пути для простого статического веб-сайта. 

{
    "source" : " ./public " ,
    "target" : " s3://websync-basic-example-bucket " ,
    "exclude" : " *.exclude " ,
    "modifiers" : {
        "!*.*" : {
            "ContentType" : " text/html "
        }
    }
}

API предмета

Объект Item Websync — это интерфейс, который абстрактно представляет либо локальный файл, либо объект S3 . Что касается Configuration File , объект Item , передаваемый функции- modifier , всегда находится из исходного контейнера (локального каталога или сегмента S3 ). Все Item придерживаются следующего интерфейса: 

 interface Item {
  // The "key" (path or S3 Object key)
  key : string
  // Last modification time
  modtime : Date
  // Size in bytes of the Item
  size : number
  // Whether item is a symbolic link (always false for S3)
  isSymbolicLink : boolean
  // Read the *entire* body of the item
  read ( ) : Promise < Buffer >
}

Система признания недействительной

Система недействительности Websync автоматически создает минимальное количество путей недействительности, необходимое для соответствия предоставленной политике wildcard . Это делается путем создания diff между target и source и двух деревьев: одного из элементов в diff и всех элементов в target . Затем он просматривает дерево diff (начиная с корня) и сравнивает количество дочерних элементов, признанных недействительными, с теми, которые не являются недействительными — именно здесь политика wildcard имеет решающее значение. Кроме того, вебсинхронизация определит, когда заданный путь с подстановочными знаками должен сделать недействительными все его дочерние элементы или только его прямые дочерние элементы, тем самым создавая наиболее оптимальные пути инвалидации.

ПРИМЕЧАНИЕ . Опция wildcardAll НЕ изменяет создание пути аннулирования, вместо этого к каждому сгенерированному пути добавляются подстановочные знаки. Это полезно для признания недействительными путей строки запроса для данного объекта и т. д.

Дополнительную информацию о том, как аннулирование данных работает в CloudFront, см. в документации AWS.

Подстановочные политики

Политики подстановочных знаков определяют, когда данный путь будет подстановочным , тем самым делая недействительными все или только его прямые дочерние элементы, чтобы уменьшить количество генерируемых путей недействительности. Доступны три политики от наименее строгой до самой строгой : minority , majority и unanimous .

меньшинство

Данный путь становится подстановочным знаком, когда меньшинство его дочерних элементов становится недействительным. ПРИМЕЧАНИЕ . Если требуется аннулирование, это всегда приводит к пути недействительности /* .

Пример:

Все целевые объекты:

  • /
    • /css
      • main.css
      • vendor.css
    • /js
      • main.js
    • index.html

Недействительные элементы:

  • /
    • index.html

Пути аннулирования:

  • /*

большинство

Данный путь становится подстановочным, когда большинство его дочерних элементов становятся недействительными.

Пример:

Все целевые объекты:

  • /
    • /css
      • main.css
      • vendor.css
    • /js
      • main.js
    • index.html

Недействительные элементы:

  • /
    • /css
      • main.css
      • vendor.css
    • index.html

Пути аннулирования:

  • /css/*
  • /index.html

единогласный

Данный путь становится подстановочным знаком, когда все его дочерние элементы становятся недействительными.

Пример:

Все целевые объекты:

  • /
    • /css
      • main.css
      • vendor.css
    • /js
      • main.js
    • index.html

Недействительные элементы:

  • /
    • /css
      • main.css
    • /js
      • /main.js
    • index.html

Пути аннулирования:

  • /css/main.css
  • /js/*
  • /index.html

Дорожная карта

  • Начальный интерфейс командной строки
  • Документация по программному API
  • Лучшая дорожная карта
Расширять
Дополнительная информация
Связанные приложения
Рекомендуем вам
Связанные новости Все