Skip to content

Fix #1364 Incorrect Worksheet Name on Streaming XLSX Reader #1478

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 2, 2020
Merged

Fix #1364 Incorrect Worksheet Name on Streaming XLSX Reader #1478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
47969f6
support reading names for streaming xlsx reads
antimatter15 Sep 29, 2020
14ad102
Don't use async iteration for platform compatibility
antimatter15 Sep 29, 2020
bf957d3
Merge branch 'master' into fix-1364
antimatter15 Sep 29, 2020
1dff7f8
Removing comment
antimatter15 Oct 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 24 additions & 5 deletions lib/stream/xlsx/workbook-reader.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ const iterateStream = require('../../utils/iterate-stream');
const parseSax = require('../../utils/parse-sax');

const StyleManager = require('../../xlsx/xform/style/styles-xform');
const WorkbookPropertiesManager = require('../../xlsx/xform/book/workbook-properties-xform');
const WorkbookXform = require('../../xlsx/xform/book/workbook-xform');
const RelationshipsXform = require('../../xlsx/xform/core/relationships-xform');

const WorksheetReader = require('./worksheet-reader');
const HyperlinkReader = require('./hyperlink-reader');
Expand All @@ -32,8 +33,6 @@ class WorkbookReader extends EventEmitter {

this.styles = new StyleManager();
this.styles.init();

this.properties = new WorkbookPropertiesManager();
}

_getStream(input) {
Expand Down Expand Up @@ -91,7 +90,9 @@ class WorkbookReader extends EventEmitter {
let sheetNo;
switch (entry.path) {
case '_rels/.rels':
break;
case 'xl/_rels/workbook.xml.rels':
await this._parseRels(entry);
break;
case 'xl/workbook.xml':
await this._parseWorkbook(entry);
Expand All @@ -106,7 +107,7 @@ class WorkbookReader extends EventEmitter {
if (entry.path.match(/xl\/worksheets\/sheet\d+[.]xml/)) {
match = entry.path.match(/xl\/worksheets\/sheet(\d+)[.]xml/);
sheetNo = match[1];
if (this.sharedStrings) {
if (this.sharedStrings && this.workbookRels) {
yield* this._parseWorksheet(iterateStream(entry), sheetNo);
} else {
// create temp file for each worksheet
Expand Down Expand Up @@ -153,9 +154,19 @@ class WorkbookReader extends EventEmitter {
}
}

async _parseRels(entry) {
const xform = new RelationshipsXform();
this.workbookRels = await xform.parseStream(iterateStream(entry));
}

async _parseWorkbook(entry) {
this._emitEntry({type: 'workbook'});
await this.properties.parseStream(iterateStream(entry));

const workbook = new WorkbookXform();
await workbook.parseStream(iterateStream(entry));

this.properties = workbook.map.workbookPr;
this.model = workbook.model;
}

async *_parseSharedStrings(entry) {
Expand Down Expand Up @@ -286,6 +297,14 @@ class WorkbookReader extends EventEmitter {
iterator,
options: this.options,
});

const matchingRel = (this.workbookRels || []).find(rel => rel.Target === `worksheets/sheet${sheetNo}.xml`);
const matchingSheet = matchingRel && (this.model.sheets || []).find(sheet => sheet.rId === matchingRel.Id);
if (matchingSheet) {
worksheetReader.id = matchingSheet.id;
worksheetReader.name = matchingSheet.name;
worksheetReader.state = matchingSheet.state;
}
if (this.options.worksheets === 'emit') {
yield {eventType: 'worksheet', value: worksheetReader};
}
Expand Down
Binary file added spec/integration/data/test-issue-1364.xlsx
View file
Open in desktop
Binary file not shown.
13 changes: 13 additions & 0 deletions spec/integration/issues/issue-1364-incorrect-worksheet-name-streaming-xlsx.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
const ExcelJS = verquire('exceljs');

const TEST_XLSX_FILE_NAME = './spec/integration/data/test-issue-1364.xlsx';

describe('github issues', () => {
it('issue 1364 - Incorrect Worksheet Name on Streaming XLSX Reader', async () => {
const workbookReader = new ExcelJS.stream.xlsx.WorkbookReader(TEST_XLSX_FILE_NAME, {});
workbookReader.read();
workbookReader.on('worksheet', worksheet => {
expect(worksheet.name).to.equal('Sum Worksheet');
})
});
});